home *** CD-ROM | disk | FTP | other *** search
/ Precision Software Appli…tions Silver Collection 1 / Precision Software Applications Silver Collection Volume One (PSM) (1993).iso / tutor / dosguide.exe / HELPDOS.ZIP / HELPDOS.DOC < prev    next >
Text File  |  1990-01-19  |  21KB  |  603 lines
  1.                                        tm
  2.                                 HelpDOS
  3.                               USER'S GUIDE
  4.  
  5.                      Copyright 86, 87, 88, 89, 90
  6.                                   by
  7.                            Help Technologies
  8.                            17955 Plaza Oriente
  9.                            Sonora, CA 95370
  10.                             (209) 532-1062
  11.  
  12.  
  13. This document repeats and covers much of the information in the printed
  14. HelpDOS USER'S GUIDE included with the registered version.  The Software
  15. and Help Files are the same as in the registered version for DOS Version
  16. 2.X.  HelpDOS for DOS Versions 2.X, 3.0, 3.1, 3.2, 3.3 and 4.0 is
  17. available from Help Technologies.  Support for future versions of DOS is
  18. planned.
  19.  
  20.                            COPYRIGHT NOTICE
  21.  
  22. The HelpDOS Software, Help Files and accompanying Documentation are
  23. copyrighted. Copies of this Software, Help Files and this accompanying
  24. Documentation may be made for distribution under the User Supported Concept
  25. where free distribution of software may be made with the understanding that
  26. satisfied users are obliged to pay a registration fee as described
  27. below. The Help Files and this accompanying Documentation may not be
  28. altered in any way.  This software may not be sold for more than a
  29. nominal disk fee except by Help Technologies or their direct assignees.
  30. Electronic distribution of copies of this Software, Help Files and this
  31. accompanying Documentation may be made via Bulletin Boards, Communication
  32. Services Networks, etc. The complete set of Software, Help Files and this
  33. accompanying Documentation must be distributed together without any
  34. alterations.  No other use is allowed unless expressly permitted under
  35. law or by Help Technologies.
  36.  
  37.  
  38.                            TABLE OF CONTENTS
  39.  
  40.         i........Warranty, Liability, Trademark statements
  41.  
  42.        ii........Registration Information
  43.  
  44.       iii........Registration Form
  45.  
  46.         1........Introduction
  47.  
  48.         2........Installing HelpDOS
  49.  
  50.         5........Using HelpDOS
  51.  
  52.         8........Problem Determination
  53.  
  54.  
  55.  
  56.                                    i
  57.  
  58.  
  59.                            LIMITED WARRANTY
  60.  
  61. HELP TECHNOLOGIES MAKES NO WARRANTY OF FITNESS FOR ANY PARTICULAR
  62. PURPOSE AND MAKES NO WARRANTIES, EXPRESS OR IMPLIED.
  63.  
  64. A limited Warranty of the media on which the Software is recorded is
  65. supplied with the registered version of HelpDOS. This warranty is
  66. supplied, in writing, with that version.
  67.  
  68. Some states do not allow limitations on how long the implied warranty
  69. lasts, so that the above limitations may not apply to you. This warranty
  70. gives you specific legal rights and you may also have other rights which
  71. vary from state to state.
  72.  
  73.  
  74.  
  75.                                LIABILITY
  76.  
  77. Help Technologies, its software suppliers, distributors and dealers,
  78. make no warranties or representations, either expressed or implied, as
  79. to the Software, Help Files and Documentation, including without
  80. limitation, the condition of the Software and Help Files and the implied
  81. warranties of its merchantability or fitness for a particular purpose.
  82. THE SOFTWARE, HELP FILES AND DOCUMENTATION ARE SOLD ON AN "AS IS" BASIS
  83. AND SHOULD THERE ARISE A DEFECT IN THESE GOODS FOLLOWING PURCHASE, THE
  84. PURCHASER SHALL ASSUME THE RISK AND BE FULLY RESPONSIBLE FOR REPAIR OR
  85. REPLACEMENT.
  86.  
  87. Help Technologies' liability in all respects is expressly limited to the
  88. remedy set forth herein, and Help Technologies shall not be liable for
  89. any lost profits or for any direct, indirect, incidental or
  90. consequential or other damages suffered by the purchaser or others
  91. resulting from the use of the Software or Help Files.
  92.  
  93. Some states do not allow the exclusion or limitation of incidental or
  94. consequential damages, so the above limitation or exclusion may not
  95. apply to you.
  96.  
  97.  
  98.                               TRADEMARKS
  99.  
  100. HelpDOS is a trademark of Help Technologies.  Where the term DOS is used
  101. in this documentation, reference is implied to PC-DOS (a registered
  102. trademark of International Business Machines Corporation) or MS-DOS (a
  103. registered trademark of Microsoft, Inc.) Where the term DOS is used we
  104. do not intend to use these trademarks in a generic sense.
  105.  
  106.  
  107.  
  108.                                   ii
  109.  
  110.  
  111.                            REGISTRATION FEES
  112.  
  113.  
  114. Satisfied users are expected to pay a registration fee as follows:
  115.  
  116. Private or Company use by individuals.
  117.  
  118.      Fee: $ 20.00
  119.  
  120.      For this you get:
  121.  
  122.         -->  Acknowledgement of payment.
  123.  
  124.         -->  The next major update on disk upon its release.
  125.  
  126.         -->  The commercial HelpDOS User's Guide and diskette.  The
  127.              diskette will contain help for the version of DOS you request.
  128.              Currently HelpDOS is available for DOS Versions 2.0
  129.              through 4.0.  The printed User's Guide contains complete
  130.              instructions on HelpDOS, including detailed information on
  131.              adding your own Help files and menus.
  132.  
  133.         -->  Telephone support from Help Technologies.
  134.  
  135.         -->  Notification of new releases.
  136.  
  137.         -->  Reduced fees for new releases (the fee for the most recent
  138.              update was $5).
  139.  
  140.  
  141. Note:  Company or Institution Site Licenses are available.  Fees are
  142.        very reasonable.  Contact Help Technologies for details.
  143.  
  144.  
  145.  
  146.                                  iii
  147.  
  148.  
  149.                                HELPDOS
  150.  
  151.                           REGISTRATION FORM
  152.  
  153.  
  154.  
  155.  
  156. ___________________________________________________________________
  157. Name
  158.  
  159. ___________________________________________________________________
  160. Address
  161.  
  162. ___________________________________________________________________
  163. Address
  164.  
  165. ___________________________________________________________________
  166. Address
  167.  
  168. ___________________________________________________________________
  169. Address
  170.  
  171. ___________________________________________________________________
  172. Telephone
  173.  
  174.  
  175. Send HelpDOS on:  ___ 5 1/4" disk   ___ 3 1/2" disk
  176.  
  177.   for DOS:  ___ 2.X   ___ 3.0   ___ 3.1   ___ 3.2   ___ 3.3   ___ 4.0
  178.  
  179.  
  180. Quantity:   _______ Single User Registrations ($20)
  181.  
  182.             _______ Sales Tax (California Residents Only)
  183.  
  184.             _______ Outside US, add $5 Shipping
  185.  
  186.             _______ Order Total
  187.  
  188.  
  189. Send Check or Money Order payable to Help Technologies.  Company purchase
  190. orders accepted; net 30.  Outside US: payment must be in US funds against
  191. US banks.
  192.  
  193.                            Help Technologies
  194.                           17955 Plaza Oriente
  195.                            Sonora, CA 95370
  196.  
  197.                              209-532-1062
  198.  
  199.  
  200.  
  201.  
  202.  
  203.                                    1
  204.  
  205.  
  206.                              INTRODUCTION
  207.  
  208. HelpDOS is a "Help System" for DOS. HelpDOS consists of menus,
  209. detail reference information, a technical dictionary and a
  210. cross-reference feature called "Hints." These components work together
  211. to show you, quickly and easily, what DOS can do and how to use it.
  212.  
  213. Menus give an "at a glance" view of DOS Commands, Special Keyboard
  214. Keys and Batch Subcommands. The menus show you what DOS can do. You can
  215. get detail reference information for each DOS command by selecting it
  216. from a menu. The detail information explains what the command does and
  217. how to use it.
  218.  
  219. A Technical Dictionary explains the terms that are frequently used with
  220. DOS and personal computers. In addition to defining the terms, the
  221. dictionary contains additional reference information and usage notes.
  222.  
  223. The Hints Menu shows categories of actions you can take with DOS. When
  224. you select a Hint category from the menu, HelpDOS will show you a menu
  225. of the DOS commands that pertain to that category.  For example, when
  226. you select the Hint category "Print," HelpDOS will give you a menu of
  227. the ways you can print information with DOS. The Hints feature is a
  228. unique and powerful aspect of HelpDOS.  It helps you find the right DOS
  229. command for your task and exposes you to related commands you may not
  230. have known about.
  231.  
  232. You may add your own help files and menus to HelpDOS. This provides a
  233. convenient way to view reference information for your special programs,
  234. batch files, procedures, or whatever you wish to have on-line. Adding
  235. help information to HelpDOS is easy. You simply create and modify these
  236. files with your word processor or editor, and update the appropriate
  237. HelpDOS menu. Detailed information about the process is provided to
  238. registered users in the printed HelpDOS User's Guide.
  239.  
  240.  
  241.  
  242.                                    2
  243.  
  244.  
  245.                           INSTALLING HelpDOS
  246.  
  247. This diskette contains help information for DOS Version 2.X. (Note: Help
  248. for DOS Versions 2.X through 4.0 is available from Help Technologies).
  249.  
  250. You may run HelpDOS from diskette or install the system on a fixed disk.
  251.  
  252. There are three steps to the installation process:
  253.  
  254. 1. Make a copy of your HelpDOS diskette. (below)
  255. 2. Perform the installation. (below to page 3)
  256. 3. Run the HelpSET program to set configuration options. (page 4)
  257.  
  258.  
  259.  
  260.                  Make a copy of your HelpDOS diskette
  261.                  *----------------------------------*
  262.  
  263. You should make a copy of your HelpDOS diskette as follows.  This
  264. provides a backup in case your original diskette becomes lost or
  265. unusable.  If your are installing HelpDOS on a fixed disk you may skip
  266. this step.
  267.  
  268. 1. Boot up your machine as per normal.
  269. 2. With your DOS diskette in drive A or the DISKCOPY command
  270.    available via a path on your fixed disk enter:
  271.  
  272.         DISKCOPY           (if you have one diskette drive)
  273.         DISKCOPY A: B:     (if you have two diskette drives)
  274.  
  275.    Follow the prompts to copy the "Source Diskette" (this disk) to the
  276.    "Target Diskette" (the copy to be made).
  277.  
  278.  
  279.                       Performing the Installation
  280.                       *-------------------------*
  281.  
  282. HelpDOS can be installed on a diskette or a fixed disk.  If you are
  283. going to use HelpDOS on a diskette, all you need to do is run the
  284. HelpSET program to establish configuration settings.  See the section
  285. "HelpSET Configuration Settings" on page 4 for details.
  286.  
  287. NOTE: If your computer has just 128k of memory you should copy the
  288. COMMAND.COM file from your DOS diskette to the diskette where HelpDOS is
  289. installed. If this is not done, DOS will prompt you to insert a diskette
  290. with COMMAND.COM each time you quit the HelpDOS program.
  291.  
  292. To install HelpDOS on a fixed disk, follow the instructions below.
  293.  
  294.  
  295.  
  296.                                    3
  297.  
  298.  
  299.                   Installing HelpDOS on a Fixed Disk
  300.                   *--------------------------------*
  301.  
  302. On a fixed disk, HelpDOS must be installed in a subdirectory named HelpDOS.
  303. Use the instructions below:
  304.  
  305. 1. Put the HelpDOS diskette in drive A.
  306. 2. Set the default drive to the fixed disk.  For example, if your fixed
  307.    disk is drive C, enter:  C:
  308. 3. Use the DOS command, MKDIR ("make directory") to create the HELPDOS
  309.    subdirectory.  Enter:   MKDIR \HELPDOS
  310. 4. Copy all files from the HelpDOS diskette to the \HELPDOS directory
  311.    on the fixed drive by entering:
  312.         COPY A:*.* C:\HELPDOS
  313.  
  314.    Note:  you can also install from diskette drive B.  In this case the
  315.    COPY command would be:    COPY B:*.* C:\HELPDOS
  316.  
  317.  
  318. Next, you need to add a path setting to an AUTOEXEC.BAT file on your
  319. fixed disk. By having a PATH command in an AUTOEXEC.BAT file, you can
  320. access the HelpDOS system without having to change the current directory
  321. to HELPDOS and without having to set the default drive to the fixed
  322. disk.
  323.  
  324.    Note: The AUTOEXEC.BAT file is run every time you start-up or re-boot
  325.          the computer. Putting the PATH command in the AUTOEXEC.BAT file
  326.          ensures that the path setting will be in effect each time you
  327.          use the computer.
  328.  
  329.  
  330. If you DO NOT have an AUTOEXEC.BAT file on your fixed disk, you should
  331. create one (in the root directory) by entering the following lines:
  332.  
  333.         CD\
  334.         COPY CON: AUTOEXEC.BAT
  335.         DATE
  336.         TIME
  337.         PATH x:\HELPDOS;x:\
  338.  
  339. where "x" is the drive letter of your fixed disk.
  340.  
  341. Next press F6 (which denotes the end-of-file). Then press RETURN, and
  342. the file will be created.
  343.  
  344. If you already have an AUTOEXEC.BAT file, edit the file and add the PATH
  345. command given above or append       ;x:\HELPDOS        to the end of it.
  346.  
  347.       where "x" is the drive letter of your fixed disk.
  348.  
  349. Re-boot your machine and the path will be set.  Be sure to run the
  350. HelpSET program before using HelpDOS (see next page).
  351.  
  352.  
  353.  
  354.                                    4
  355.  
  356.  
  357.                     HelpSET Configuration Settings
  358.                     *----------------------------*
  359.  
  360. HelpSET is a menu-driven program which establishes configuration
  361. settings for HelpDOS.
  362.  
  363. HelpSET performs three functions:
  364.  
  365. 1. Sets the display screen type to monochrome or color. (default is
  366.    monochrome)
  367.  
  368. 2. Sets the colors to be used for a color display. You may choose the
  369.    colors to be used for the Status Line, the Function Key line and menu
  370.    selection letters, and the Help text. As you select colors, HelpSET
  371.    shows you how they will appear in HelpDOS. Experiment with different
  372.    color combinations until you find the one you like best.
  373.  
  374. 3. Sets Beeps to ON or OFF. If Beeps are ON, HelpDOS will beep when an
  375.    inactive key is pressed and when an error message is displayed.
  376.    HelpDOS will function properly with Beeps OFF but you will not be
  377.    informed when an inactive key is pressed. (default is Beeps OFF)
  378.  
  379.  
  380.  
  381.                             Running HelpSET
  382.                             *-------------*
  383.  
  384. 1. Set the default drive and directory to the installed HelpDOS program.
  385.    If you installed HelpDOS in a \HelpDOS directory on a fixed disk you
  386.    will need to use the command:   CD \HELPDOS    to set the current
  387.    directory on the fixed disk to the HELPDOS directory.
  388.  
  389. 2. Start HelpSET by entering:        HELPSET
  390.  
  391.    HelpSET will give you easy to follow menus for establishing your
  392.    configuration settings.
  393.  
  394.    This program reads and writes the HELPSET.UP file in the current
  395.    directory.  The disk containing the installed HelpDOS program
  396.    must not be write-protected.
  397.  
  398.  
  399.  
  400.                                    5
  401.  
  402.  
  403.                              USING HelpDOS
  404.  
  405.  
  406. After installing HelpDOS as shown on pages 2 thru 4, start HelpDOS by
  407. entering:
  408.                              HELP
  409.  
  410.  
  411. For help with a specific DOS command, you may enter the name of the
  412. command when HelpDOS is started.  For example, to get help on the RENAME
  413. command you would enter:     HELP RENAME
  414.  
  415. You can also select a HelpDOS menu at startup by specifying "menu"
  416. followed by the menu name.  For example, to select the COMMANDS menu upon
  417. startup you would enter:     HELP MENU COMMANDS
  418.  
  419.  
  420. If you do not make a selection at startup (that is, you entered just
  421. HELP) you will see a display that looks like this:
  422.  
  423.  
  424. +----------------------------------------------------------------------+
  425. | Help Menus                                                   6 lines |
  426. |                                                                      |
  427. |                                                                      |
  428. | A  ADVANCED    - Advanced DOS Commands                               |
  429. | B  BATCH       - Batch Subcommands                                   |
  430. | C  COMMANDS    - DOS Commands                                        |
  431. | D  KEYBOARD    - Special Keyboard Keys                               |
  432. | E  OVERVIEW    - Overviews of DOS Facilities                         |
  433. |                                                                      |
  434. |                                                                      |
  435. | F1 Help   F2 Print   F3 Menus   F4 Hints   F5 Terms         F9 Quit  |
  436. +----------------------------------------------------------------------+
  437.  
  438.  
  439.  
  440.  
  441.                         Status Line (top line)
  442.  
  443. The left side of the status line identifies the help information you are
  444. viewing. The right side of the status line gives the number of lines in
  445. the help information.
  446.  
  447. When you make a selection from a menu, the name of the selected
  448. information is appended to the previous identifier on the status line.
  449. This identifies the current information and tells you which menu it was
  450. selected from.
  451.  
  452.  
  453.  
  454.                                    6
  455.  
  456.  
  457.                              Function Keys
  458.  
  459. The Function Key line displays the function keys used by HelpDOS.
  460. Pressing one of these function keys triggers a HelpDOS feature.
  461.  
  462.  
  463.  
  464. F1 Help
  465.  
  466. F1 displays a help screen containing a brief summary of HelpDOS'
  467. features. It also contains a summary of the Format Notation which
  468. HelpDOS uses to explain the parameters of DOS Commands. F1 is a "toggle
  469. key." Press F1 to display the help screen. Press F1 again to remove it.
  470.  
  471.  
  472.  
  473. F2 Print
  474.  
  475. F2 prints all lines of the current help information. Once printing has
  476. begun, you may cancel it by pressing F10.
  477.  
  478.  
  479.  
  480. F3 Menus
  481.  
  482. F3 shows the Help Menus and presents them for your selection.  HelpDOS
  483. comes with the menus shown on page 5.  Menus you may add to HelpDOS
  484. will also appear when you press F3. HelpDOS automatically presents this
  485. menu of menus unless you select a menu or a help item when you start the
  486. program.
  487.  
  488.  
  489.  
  490. F4 Hints
  491.  
  492. F4 activates the Hints feature and presents you with a menu of Hint
  493. categories. When you select a hint, HelpDOS gives you a menu of one or
  494. more DOS commands that pertain to the hint category.  You may then
  495. select items from this new menu to see the detail information.
  496.  
  497.  
  498.  
  499. F5 Terms
  500.  
  501. F5 presents you with a menu of the terms in the technical dictionary.
  502. You may then select a term from the menu. The information will include a
  503. definition of the term and, when applicable, examples and references to
  504. related information.
  505.  
  506.  
  507.  
  508.                                    7
  509.  
  510.  
  511. F6 Return
  512.  
  513. F6 returns you to the prior menu. This appears on the function key line
  514. ONLY after a selection has been made from a menu. Pressing F6 will
  515. return you to the menu where your previous selection was made.
  516.  
  517.  
  518.  
  519. F9 Quit
  520.  
  521. F9 ends HelpDOS and returns you to DOS. On most computers, the screen
  522. will not be cleared when you are returned to DOS. This allows you to
  523. position the HelpDOS display to the appropriate information and then
  524. press F9 to return to DOS leaving the help information you were viewing
  525. on the screen for your reference.
  526.  
  527.  
  528.  
  529.  
  530.  
  531. Display Scrolling Keys
  532.  
  533. Help information that has more than 21 lines may be scrolled forward and
  534. backward for viewing.
  535.  
  536.         Home       - Positions the display to the top.
  537.         End        - Positions the display to the end.
  538.         Up Arrow   - Moves the display one line toward the top.
  539.         Down Arrow - Moves the display one line toward the end.
  540.         PgDn       - Moves the display forward one screen.
  541.         PgUp       - Moves the display backward one screen.
  542.  
  543.  
  544.  
  545.  
  546.  
  547. Selecting a Menu Item
  548.  
  549. Menu items are prefaced with the letters A through U. To select a menu
  550. item, press the letter representing your choice. You do not press the
  551. Return key.
  552.  
  553. Some menus have more choices than the screen can display. Use the
  554. Display Scrolling Keys as above to scroll the menu to the item of your
  555. choice. The letters associated with the menu items are reassigned when
  556. the display is scrolled.
  557.  
  558.  
  559.  
  560.                                    8
  561.  
  562.  
  563.                          Problem Determination
  564.  
  565.  
  566.  
  567.  
  568. Problem: the scrolling keys do not work.
  569.  
  570. Reason:  With 21 or fewer lines, the display will not scroll.
  571.  
  572.             -- or --
  573.  
  574.          The keypad is set to "numeric mode." Press the NumLock
  575.          key to change it to "cursor mode."
  576.  
  577.  
  578.  
  579.  
  580. Problem: HelpDOS is not using the settings I specified in HelpSET.
  581.  
  582. Reason:  The current directory was not set to the directory containing
  583.          HelpDOS when HelpSET was run. HelpSET always writes the setup
  584.          file, HELPSET.UP, to the current directory. Be sure the current
  585.          directory is set to the directory (root or \HELPDOS) where
  586.          HelpDOS is installed before running HelpSET.
  587.  
  588.  
  589.  
  590.  
  591. Problem: When I enter HELP to start HelpDOS, I get the message "Bad
  592.          command or file name" even though the HelpDOS disk is in the
  593.          drive.
  594.  
  595. Reason:  The default drive is not set to the disk containing HelpDOS
  596.          and/or the current directory is not set to the root directory.
  597.  
  598.             -- or --
  599.  
  600.          The DOS "path setting" may be incorrect if HelpDOS is installed
  601.          in a \HELPDOS subdirectory on a fixed disk.  Review the HelpDOS
  602.          installation instructions on page 3 for details on the DOS path.
  603.